PHP函数：export 和 export_escape，用于将数据导出为 CSV 文件

2024-05-08 • PHP CSV 数据导出

PHP 代码定义了两个函数：export 和 export_escape，用于将数据导出为 CSV 文件。以下是每个函数的详细解释：

`export` 函数

这个函数接受两个参数：$result（包含要导出的数据）和 $columns（包含要导出的列名）。

设置文件名：基于当前时间（$fileTime）和表名（如果存在）来设置 CSV 文件的名称。
检查输出缓冲：使用 ob_get_status(true) 来获取当前的输出缓冲状态。如果没有任何输出缓冲，则显示错误并退出。
清理输出缓冲：使用 ob_end_clean() 清理所有 PHP 输出缓冲层。
设置 HTTP 响应头：设置适当的 HTTP 响应头以指示这是一个 CSV 文件下载，并指定文件名。
输出 BOM 头：在 CSV 内容前输出 UTF-8 的 BOM（Byte Order Mark），以确保文件在 Excel 中正确打开。
处理列：如果最后一列是标识列（例如包含编辑和删除链接），则将其从 $columns 数组中移除。
输出标题：遍历 $columns 数组并输出 CSV 的列标题。
输出数据：遍历 $result 数组，并根据 $columns 中的列名来输出每行的数据。
结束输出缓冲：使用 ob_end_flush() 发送内容并关闭输出缓冲。然后，使用 exit() 退出脚本以防止进一步的输出。

`export_escape` 函数

这个函数接受两个参数：$str（要转义的字符串）和 $column_index（当前列的索引）。

替换分隔符：在字符串 $str 中，将分隔符（默认为逗号或其他定义的分隔符）替换为转义的分隔符（例如，两个连续的分隔符）。这是为了确保 CSV 中的数据字段不会意外地包含分隔符，从而导致字段被错误地拆分。
添加分隔符：根据 $column_index，在字符串 $str 前后添加分隔符。如果 $column_index 为 0（即第一列），则只在前面添加分隔符；否则，在前后都添加分隔符。

注意事项

在实际使用中，$this->table、$this->table_id_name、$this->export_delim、$this->export_delim_escape 和 $this->export_separator 等成员变量需要在类的其他部分定义，以确保 export 和 export_escape 函数能够正常工作。
使用 ob_start('ob_gzhandler') 尝试启用 gzip 压缩。如果失败，则回退到普通的 ob_start()。这可以提高文件下载的速度，但前提是客户端支持 gzip 压缩。
在输出 CSV 内容之前，务必确保没有其他 PHP 输出（例如，在脚本的其他部分通过 echo 或 print 输出的内容），否则这些输出可能会干扰 CSV 文件的生成。
public function export($result, $columns)
{

$fileTime = date('YmdHis');
$fileName = ($this->table) ? $this->table . '_' . $fileTime . '.csv' : 'download_' . $fileTime . '.csv';

$arr = ob_get_status(true);
if (empty($arr)) {
$this->display_error("必须在脚本开始时调用ob_start（）或ob_start（'ob.gzhandler'）才能使用CSV导出。", 'export()');
return;
}

// 清理所有 PHP 输出缓冲层
while ($buffer = array_shift($arr)) {
ob_end_clean();
}

// 确保输出缓冲是开启的
if (!ob_start('ob_gzhandler')) {
ob_start();
}
header("Cache-Control: max-age=1");
header("Pragma: public");
header("Content-Type: text/csv; charset=utf-8"); // 明确指定CSV的MIME类型和字符集
header("Content-Disposition: attachment; filename=$fileName");

echo chr(0xEF).chr(0xBB).chr(0xBF); // 输出BOM头
// 移除最后一列，如果它是标识列（包含[编辑]和[删除]链接）
if (end($columns) === $this->table_id_name) {
array_pop($columns);
}

// 标题
$column_index = 0;
// 输出列标题
foreach ($columns as $key => $val) {
echo $this->export_escape($val, $column_index++);
}
echo "\n";

// 遍历数据并输出每一行
foreach ($result as $row) {

$column_index = 0;
foreach ($columns as $val) {
echo $this->export_escape($row[$val], $column_index++);
}
echo "\n";
}

ob_end_flush(); // 发送内容并关闭输出缓冲
exit();

}

public function export_escape($str, $column_index)
{
$str = str_replace($this->export_delim, $this->export_delim_escape . $this->export_delim, $str ?? '');

if ($column_index == 0) {
return $this->export_delim . $str . $this->export_delim;
} else {
return $this->export_separator . $this->export_delim . $str . $this->export_delim;
}
}
export 和 export_escape 函数之外，PHP 导出 CSV 文件通常不会直接依赖特定的内置函数，因为 CSV 格式相对简单，主要通过处理字符串和文件操作来生成。不过，在 PHP 中有几个常见的函数和概念与 CSV 文件导出相关：

fopen() 和 fputcsv()：